<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Jumper documentation</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Jumper (v1.8.0)</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>


<h2>Modules</h2>
<ul>
  <li><a href="../modules/jumper.core.bheap.html">jumper.core.bheap</a></li>
  <li><a href="../modules/jumper.core.heuristics.html">jumper.core.heuristics</a></li>
  <li><strong>jumper.core.node</strong></li>
  <li><a href="../modules/jumper.core.path.html">jumper.core.path</a></li>
  <li><a href="../modules/jumper.grid.html">jumper.grid</a></li>
  <li><a href="../modules/jumper.pathfinder.html">jumper.pathfinder</a></li>
</ul>
<h2>Scripts</h2>
<ul>
  <li><a href="../scripts/jumper.search.astar.html">jumper.search.astar</a></li>
  <li><a href="../scripts/jumper.search.bfs.html">jumper.search.bfs</a></li>
  <li><a href="../scripts/jumper.search.dfs.html">jumper.search.dfs</a></li>
  <li><a href="../scripts/jumper.search.dijkstra.html">jumper.search.dijkstra</a></li>
  <li><a href="../scripts/jumper.search.jps.html">jumper.search.jps</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>jumper.core.node</code></h1>

<p><strong>The <code>node</code> class</strong>.</p>
<p> The <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  class represents a cell on a collision map. Basically, for each single cell
 in the collision map passed-in upon initialization, a <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  object would be generated
 and then stored within the <a href="../modules/jumper.core.node.html#jumper.grid">grid</a>  object.</p>

<p> In the following implementation, nodes can be compared using the <code>&lt;</code> operator. The comparison is
 made on the basis of their <code>f</code> cost. From a processed node, the <a href="../modules/jumper.core.node.html#jumper.pathfinder">pathfinder</a>  would expand the search
 to the next neighbouring node having the lowest <code>f</code> cost. This comparison is internally used within the
 <em>open list</em> <code>heap</code> to quickly sort all nodes queued inside the heap.
 </p>
    <h3>Info:</h3>
    <ul>
        <li><strong>Copyright</strong>: 2012-2013</li>
        <li><strong>License</strong>: <a href="http://www.opensource.org/licenses/mit-license.php">MIT</a></li>
        <li><strong>Author</strong>: Roland Yonaba</li>
    </ul>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#node:new">node:new&nbsp;(x, y)</a></td>
	<td class="summary">Inits a new <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  object</td>
	</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#node">node</a></td>
	<td class="summary">Internal <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  Class</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "node:new"></a>
    <strong>node:new&nbsp;(x, y)</strong>
    </dt>
    <dd>
    Inits a new <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  object

    <h3>Parameters:</h3>
    <ul>
      <li><span class="parameter">x</span>
        <span class="types"><span class="type">int</span></span>
       the x-coordinate of the node on the collision map</li>
      <li><span class="parameter">y</span>
        <span class="types"><span class="type">int</span></span>
       the y-coordinate of the node on the collision map</li>
    </ul>

    <h3>Returns:</h3>
    <ol>

          <span class="types"><a class="type" href="../modules/jumper.core.node.html#jumper.core.node">node</a></span>
        a new <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  object
    </ol>




</dd>
</dl>
    <h2><a name="Tables"></a>Tables</h2>

    <dl class="function">
    <dt>
    <a name = "node"></a>
    <strong>node</strong>
    </dt>
    <dd>
    Internal <a href="../modules/jumper.core.node.html#jumper.core.node">node</a>  Class

    <h3>Fields:</h3>
    <ul>
      <li><span class="parameter">x</span>
       the x-coordinate of the node on the collision map</li>
      <li><span class="parameter">y</span>
       the y-coordinate of the node on the collision map</li>
      <li><span class="parameter">g</span>
       the G-cost of the node (exists only during a path search)</li>
      <li><span class="parameter">f</span>
       the F-cost of the node (exists only during a path search)</li>
      <li><span class="parameter">h</span>
       the F-cost of the node (exists only during a path search)</li>
      <li><span class="parameter">parent</span>
       a reference to the parent of the current node, used for backtracking upon a path search completion (exists only during a path search).</li>
    </ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.3</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
